home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 001a / bigard14.zip / BI-GARD.DOC next >
Text File  |  1990-09-30  |  15KB  |  347 lines

  1.  
  2.         BI-GARD  The Bimodem interface for Telegard  Release 1.4
  3.                               by Alan Chavis
  4.  
  5.  
  6.  
  7.                                 Disclaimer
  8.  
  9. This product is provided "as is" without warranty of any kind.  The author 
  10. does not warrant, guarantee, or make any representations regarding the use 
  11. of, or the results of the use of the program, and you rely on the program 
  12. and results solely at your own risk.  The author will not be held responsible
  13. for system damage, loss of profit, or any other special, incidental, or 
  14. consequential damages resulting from the use or inability to use this product.
  15.  
  16. This program may be freely copied and distributed, providing it is not mod-
  17. ified in any way, without express written consent of the author.
  18.  
  19. THIS INTERFACE WILL ONLY WORK WITH BIMODEM 1.22 OR LATER!  Do NOT attempt to
  20. use it with 1.20 or earlier, as you will most likely mess everything up!  The
  21. remote caller may use Bimodem 1.20 or 1.22.
  22.  
  23. Special thanks to Martin Pollard of Telegard, Dave Krause of Bimodem,
  24. Robert Jackson of Modemlink BBS, Donald Butterfield of Butterscan BBS,
  25. and the numerous BETA testers!  Without them this program would not be!
  26.  
  27. Please direct all questions, comments, and suggestions to Alan Chavis, via
  28. one of the following BBS:
  29.  
  30.                Modemlink BBS               PowerQuest BBS
  31.                (405)354-6024               (405)722-0402
  32.                Robert Jackson               Alan Chavis
  33.                  1:147/24                    1:147/55
  34.  
  35.  
  36.                             THE BIMODEM CONCEPT
  37.  
  38. Bimodem is a really wonderful protocol.  It provides many great features that
  39. benefit both the user and the BBS.  I have found that most users will take the
  40. time to find something to send when using Bimodem, and that they upload more
  41. often, because it does not take any extra time to do so.  I feel that it is as
  42. much of a benefit to users.  As a user I can easily prepare transfers in ad-
  43. vance, before I call the BBS, I can set up middle of the night transfers ef-
  44. fortlessly, and if I see a file that I want while on-line, all I have to do
  45. is tag it with my Hot-Key Utility and go.  I hate entering filenames, and I 
  46. hate remembering them even more.  What I hate the most is having to enter the
  47. silly thing twice for uploads...Once on the BBS end, and once on mine!  Talk
  48. about discouraging uploads!  Now anytime I see a file on my disk that I want 
  49. to send to someone, I just enter it into a Bimodem.pth file and let it sit
  50. there until the next time I call that BBS.  Then I just tag a few that I 
  51. would like and start Bimodem.  EASY!  With the registered version, you can 
  52. add/kill files right in the middle of a transfer!
  53.  
  54. Why an interface?  Well the main problem with this wonderful protocol is that
  55. when you set up an upload on your end, you enter the description on your end.
  56. You could just put the uploaded files in the Telegard TEMP directory, but 
  57. then the user has to waste time entering the description after the transfer
  58. (The worst possible time...I am usually asleep by the time its all over!).
  59. So you have to get the description into Telegard some other way.  Just a 
  60. matter of adding it to the proper *.dir file, really.  And if you're going 
  61. to that, why not update the download counters and user data while you're at
  62. it?  Bi-Gard is born.  Bi-Gard reads a special Bimodem log file, adds uploads
  63. to the filebases, increments the download counters, credits/debits filepoints,
  64. updates the system records, and reports activity to the SYSOP.LOG file.  It
  65. also puts uploads into the current filebase (just like other TG protocols),
  66. sounds an alarm when Bimodem is used (defeatable,name that tune), and can
  67. determine if a transfer was aborted or not (among other things).
  68.  
  69. If after reading the docs, you run into a problem you can't solve, please 
  70. contact me, and I'll solve it for you.  Thanks for using Bi-Gard!
  71.  
  72.  
  73.                                  REVISIONS
  74.  
  75. 1.4  -  Corrected a bug experienced when upload path was on a different
  76.         drive than other directories.
  77.  
  78. 1.3  -  The 'U' option was not working correctly.  Fixed
  79.  
  80. 1.2  -  If sysop hours were not declared, the alarm did not function.  Fixed
  81.  
  82. 1.1  -  Bi-Gard 1.0 was not properly restoring the original Bimodem Receive
  83.         Path after a Bimodem Transfer.  This has been fixed.
  84.  
  85. 1.0  -  Initial Release
  86.  
  87.                             SETTING UP BI-GARD
  88.  
  89. ■   Bi-Gard has access to the following files when it is running.  
  90.  
  91.     BIMODEM.CFG     {The Bimodem configuration file}
  92.           *.DIR     {ALL of the Telegard Filebase Data Files}
  93.      STATUS.DAT
  94.        USER.LST
  95.       SYSOP.LOG
  96.        ZLOG.DAT
  97.  
  98.     It is important to note that Bi-Gard has access to ANY *.DIR files in
  99.     the GFILES path, whether or not they are used by Telegard.  The reason
  100.     for this is that Bi-Gard has no way to determine what *.DIR file a down-
  101.     loaded file is in, so it has to search EVERY *.DIR file until it finds
  102.     a matching file record.  See Note below.
  103.  
  104. ■   You will need to put BI-GARD.EXE, BIMODEM.COM, and BIMODEM.CFG in the 
  105.     same directory and set the environment variable BGCFG so that it points
  106.     to that directory.  Make sure this directory is in your path statement.
  107.  
  108.     EXAMPLE:   SET BGCFG=C:\BIMODEM\
  109.  
  110.     Also, if your BBS directory is not C:\BBS\, you'll need to set BBS= so
  111.     that Bi-Gard can find the sysop log file.  
  112.  
  113.     EXAMPLE:   SET BBS=C:\PATH\TO\BBS\DIR\
  114.  
  115.  
  116. ■  To set up Bi-Gard, create a new menu command on the FILES menu.
  117.     
  118.     CMD letters  : /B  (This can be whatever you want)
  119.     CmdKeys      : D-
  120.     Mstring      : Bi-Gard A @R @D @I @T @N
  121.                            Q              
  122.  
  123.     The parameters listed above must be entered EXACTLY as shown.
  124.     If any parameters are out of order, the results will be completely
  125.     unpredictable.
  126.  
  127.     A  = Enable Alarm  or (Q = Quiet)
  128.     @R = User's Number
  129.     @D = Current Filebase Download Path
  130.     @I = Current Filebase *.DIR file and path
  131.     @T = Number of Minutes User has left
  132.     @N = User's Name
  133.    
  134. ■   All uploads will be placed in the current Filebase.  It would be
  135.     a good idea to tell your users to change to the <MOST> appropriate
  136.     filebase for files they intend to send BEFORE using BiModem.
  137.  
  138. ■   You may wish to put all Bimodem Uploads in the same directory and
  139.     filebase every time.  
  140.  
  141.     To do this specify the 'U' parameter in the Bi-Gard MSTRING like this:   
  142.  
  143.         Bi-Gard A @R U C:\BBS\GFILES\UPLOADS.DIR @T @N 
  144.    
  145.     'Uploads.dir' should be a valid Telegard filebase, and it's upload
  146.     directory should be the same as the one you specified as the
  147.     default receive directory in BiConfig.    
  148.  
  149. ■   If you do not wish to limit the time, simply substitute a large
  150.     number for @T, say 1000 or something.  This will not disable the feature,
  151.     but it provides for a very large amount of time!
  152.     
  153. ■   'A' at the front of the Mstring enables the Alarm, 'Q' Disables it.
  154.     The alarm will only sound when enabled, scroll lock is OFF, and Telegard
  155.     Sysop hours allow paging.
  156.     
  157.     Note:  This feature does not have anything to do with the 'Sysop Page
  158.            Function' in Bimodem.  This is governed by Bimodem's sysop hours.
  159.  
  160. ■   An automatic Bimodem detector can be set up so that all the user has
  161.     to do is switch to the FILE area, and start Bimodem on their end.
  162.  
  163.     NOTE:  THIS WILL ONLY WORK IF THE USER IS USING BIMODEM 1.22 (or later)
  164.  
  165.     I use two different menu commands, one for automatic, one for manual.
  166.     They are the same as listed above except for the automatic's CMD letters:
  167.  
  168.     Automatic CMD letters: ┬   (Alt-194)
  169.  
  170.     Manual CMD letters   : /B
  171.  
  172.     When a user starts Bimodem on his end, Bimodem sends the '┬' char. and
  173.     Bi-Gard is automatically called!  This feature is available to the user
  174.     regardless of the file area he is in, but Telegard must be waiting for
  175.     a command (ie. not in the middle of a paused listing or something).
  176.  
  177.     I have found this to be a very useful feature, because as a user, I 
  178.     usually tag my downloads right off the BBS, shell to DOS and enter my
  179.     uploads, and start Bimodem from Powernode.  If the BBS is not set to 
  180.     auto-detect Bimodem, I would have to exit Powernode, return to my Term,
  181.     enter the manual '/B' command, shell back to DOS, load Powernode, and 
  182.     then start Bimodem. The Auto-Detect saves a lot of keystrokes!
  183.  
  184.  
  185.                             THINGS TO BE AWARE OF!
  186.  
  187. ■   Currently the program does not check to see if the user has sufficient
  188.     Filepoints to download a particular file as there is no way to know what
  189.     files the user will request in advance.  However, you can use Telegard's
  190.     ACS system to require at least (X) filepoints for access to Bimodem.
  191.     
  192.                  (See also Bimodem Config and Security Below)
  193.  
  194. ■   Having a pesky BIMODEM.PTH file hanging around after a local use of 
  195.     Bimodem by the Sysop is a bad deal, since Bimodem will use BOTH the remote
  196.     AND the local BIMODEM.PTH files!  Bi-Gard checks for this situation and
  197.     if it finds a BIMODEM.PTH file in the BGCFG directory, it renames it
  198.     to BMPATH.OLD.  HOWEVER, it only checks the path pointed to by BGCFG!  If
  199.     you wish to keep your BIMODEM.PTH files in a different directory, you'll 
  200.     have to find some other way to delete it!
  201.  
  202.     Hint:  Set up a batch file to delete BIMODEM.PTH
  203.  
  204.     You may wish, from time to time, to set up a transfer on the local end
  205.     so that when the user calls, all they have to do is start bimodem, since
  206.     you set up the transfer for them.  Set up the transfer normally, then
  207.     rename the BIMODEM.PTH file to BI-GARD.PTH.  Bi-Gard will detect this
  208.     transfer list and relay it to Bimodem.
  209.  
  210. ■   When updating the number of downloads for a particular file, Bi-Gard
  211.     searches each *.Dir file until it finds a matching file record.  It
  212.     then increments the number of downloads and continues.  This could be
  213.     a problem if a file is listed in more than one filebase at a time, as
  214.     only the FIRST matching record is updated.
  215.  
  216. ■   Bi-Gard may run into troubles if Telegard is set up to put dirfiles in
  217.     the download directories of the filebases, as it expects all *.dir files
  218.     to be in the GFILES path.  The GFILES path can be any valid path, however.
  219.  
  220. ■   Bi-Gard will accept up to 3 words for a user name.
  221.  
  222.  
  223.                           BIMODEM CONFIG and SECURITY
  224.  
  225. ■   IF YOU HAVE NOT READ THE BIMODEM DOCUMENTATION, PLEASE READ IT THOUROUGHLY
  226.     BEFORE USING BI-GARD.
  227.  
  228. ■   Recommended BiConfig Options:
  229.  
  230.     GENERAL OPTIONS:
  231.  
  232.     Allow current directory access         N
  233.     Allow filenames only                   Y
  234.     Rename file if it exists               N
  235.     Always verify when done                Optional
  236.     Do NOT allow source deletion           Y
  237.     Retain original file date              Y
  238.     Do NOT allow full directory transfers  Y
  239.     Do NOT allow sub directory transfers   Y
  240.     Replace timer interrupt                Optional (see Bimodem docs)
  241.     Replace keyboard interrupt             Optional (see Bimodem docs)
  242.     Allow remote file requests             Y
  243.     Allow local file requests              Y
  244.     Skip transfer if same date/time/size   N
  245.  
  246.     LIMITS AND EDITING:
  247.  
  248.     Since Bi-Gard cannot check to see if the user has sufficient filepoints,
  249.     it is recommended that you set the 'Maximum K Per Transfer' to a reason-
  250.     able limit in BiConfig.  When this limit is reached, Bimodem will drop,
  251.     allowing Bi-Gard to update filepoints, and returning to Telegard.  The 
  252.     user may then return to BiModem and resume transfers.  As long as you 
  253.     set up your Bi-Gard menu command to check for sufficient filepoints, this
  254.     should provide reasonable security against file raping.
  255.  
  256.     Maximum transfer time is automatically passed by Bi-Gard from the amount
  257.     of time the user has left.
  258.  
  259.     DOWNLOAD DEFAULTS:
  260.   
  261.     All 'No'
  262.  
  263.     UPLOAD DEFAULTS:
  264.  
  265.     All 'No'
  266.  
  267.     FILENAMES AND PATHS:
  268.  
  269.     Create a text file that contains the paths that contain downloadable
  270.     files.  I use 'FILES.LST' for the file name and it should look something
  271.     like this:
  272.  
  273.     C:\DLS\GAMES\
  274.     C:\DLS\UTILS\
  275.     C:\DLS\COMM\
  276.     C:\DLS\MISC\
  277.     etc.
  278.  
  279.     Be sure to include the '\' character at the end of each path.
  280.  
  281.     Then enter the complete path to this file:
  282.  
  283.     EXAMPLE:
  284.     
  285.     Directory or List of Directories that files are sent from:
  286.     C:\BIMODEM\FILES.LST
  287.  
  288.     USERS WILL HAVE COMPLETE ACCESS TO ANY DIRECTORY PATHS LISTED IN YOUR
  289.     FILES.LST  WHETHER OR NOT THE FILE IS LISTED IN THE TELEGARD FILEBASE!!
  290.  
  291.     If you have sensitive files that need to be accessed by certain users, 
  292.     you could create a special command on the file menu available only to 
  293.     users with a higher SL.  This Mstring would be essentially the same:
  294.     
  295.     HIBI A @R @D @I @T @N
  296.     
  297.     but it would call a batch file that looked something like this:
  298.  
  299.     (HIBI.BAT for example)
  300.     @echo off
  301.     cd\bimodem                             {or whatever directory you use}
  302.     copy HISL.LST FILES.LST                {copy the Hi Security List}
  303.     Bi-Gard %1 %2 %3 %4 %5 %6 %7 %8 %9     {call Bi-Gard}
  304.     copy REG.LST  FILES.LST                {restore the Regular List}
  305.  
  306.     You will also need to specify a rejection path list.  You may use the
  307.     same file that you used for the 'SEND' paths, but you will probably want
  308.     a seperate file that includes your SYSOP dir and any other paths you 
  309.     want checked for rejections.  The format for the 'REJECTS.LST' is the
  310.     same:
  311.  
  312.     EXAMPLE:
  313.     Directory or List of Directories that determine rejections:
  314.     C:\BIMODEM\REJECTS.LST
  315.  
  316.  
  317. ■   Again, when you are specifying filenames and paths in BiConfig,
  318.     make sure you use complete paths for EVERYTHING!!
  319.  
  320.     Make sure the path lines in your SEND directories and REJECT 
  321.     directories lists have a '\' character on the end of each path!
  322.  
  323. ■   There are a variety of Bimodem shells available from various sources
  324.     (Powernode, for example).  Your users will find Bimodem much friendlier
  325.     by using one of these, Although the newer utilities that are included
  326.     with Bimodem are good.  A Hot-Key file tagger is especially useful.
  327.  
  328.  
  329.  
  330.  
  331.                                 IDEAS WANTED!
  332.  
  333.     If you have any ideas for useful utilities for Telegard, or other 
  334.     programs drop me a note at PowerQuest and I'll take a look at them.
  335.     
  336.  
  337.     If you find this program useful and would like to see more from this
  338.     author, send your donations, 3.5 floppies, job offers, ram chips, ideas,
  339.     or whatever to:
  340.  
  341.                                 ALAN CHAVIS
  342.                                PO BOX  22078
  343.                                OKC,OK. 73123
  344.  
  345.  
  346.  
  347.